/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.period;

import com.google.common.collect.Lists;
import java.util.Date;
import java.util.List;
import org.hisp.dhis.calendar.Calendar;
import org.hisp.dhis.calendar.DateTimeUnit;

/**
 * PeriodType for yearly Periods. A valid yearly Period has startDate set to January 1st and endDate
 * set to the last day of the same year.
 *
 * @author Torgeir Lorange Ostby
 */
public class YearlyPeriodType extends CalendarPeriodType {
  /** Determines if a de-serialized file is compatible with this class. */
  private static final long serialVersionUID = 3893035414025085437L;

  private static final String ISO_FORMAT = "yyyy";

  private static final String ISO8601_DURATION = "P1Y";

  public static final int FREQUENCY_ORDER = 365;

  public static final String SQL_INTERVAL = "1 year";

  // -------------------------------------------------------------------------
  // PeriodType functionality
  // -------------------------------------------------------------------------

  @Override
  public PeriodTypeEnum getPeriodTypeEnum() {
    return PeriodTypeEnum.YEARLY;
  }

  @Override
  public Period createPeriod(DateTimeUnit dateTimeUnit, Calendar calendar) {
    DateTimeUnit start = new DateTimeUnit(dateTimeUnit);
    DateTimeUnit end = new DateTimeUnit(dateTimeUnit);

    start.setDay(1);
    start.setMonth(1);

    end.setMonth(calendar.monthsInYear());
    end.setDay(calendar.daysInMonth(end.getYear(), end.getMonth()));

    return toIsoPeriod(start, end, calendar);
  }

  @Override
  public int getFrequencyOrder() {
    return FREQUENCY_ORDER;
  }

  @Override
  public String getSqlInterval() {
    return SQL_INTERVAL;
  }

  // -------------------------------------------------------------------------
  // CalendarPeriodType functionality
  // -------------------------------------------------------------------------

  @Override
  public DateTimeUnit getDateWithOffset(DateTimeUnit dateTimeUnit, int offset, Calendar calendar) {
    return calendar.plusYears(dateTimeUnit, offset);
  }

  /** Generates yearly periods for the last 5, current and next 5 years. */
  @Override
  public List<Period> generatePeriods(DateTimeUnit dateTimeUnit) {
    Calendar calendar = getCalendar();

    dateTimeUnit = calendar.minusYears(dateTimeUnit, 5);
    dateTimeUnit.setDay(1);
    dateTimeUnit.setMonth(1);

    List<Period> periods = Lists.newArrayList();

    for (int i = 0; i < 11; ++i) {
      periods.add(createPeriod(dateTimeUnit, calendar));
      dateTimeUnit = calendar.plusYears(dateTimeUnit, 1);
    }

    return periods;
  }

  /** Generates the last 5 years where the last one is the year which the given date is inside. */
  @Override
  public List<Period> generateRollingPeriods(Date date) {
    return generateLast5Years(date);
  }

  @Override
  public List<Period> generateRollingPeriods(DateTimeUnit dateTimeUnit, Calendar calendar) {
    return generateLast5Years(calendar.toIso(dateTimeUnit).toJdkDate());
  }

  /** Generates the last 5 years where the last one is the year which the given date is inside. */
  @Override
  public List<Period> generateLast5Years(Date date) {
    Calendar calendar = getCalendar();

    DateTimeUnit dateTimeUnit = createLocalDateUnitInstance(date);
    dateTimeUnit = calendar.minusYears(dateTimeUnit, 4);
    dateTimeUnit.setDay(1);
    dateTimeUnit.setMonth(1);

    List<Period> periods = Lists.newArrayList();

    for (int i = 0; i < 5; ++i) {
      periods.add(createPeriod(dateTimeUnit, calendar));
      dateTimeUnit = calendar.plusYears(dateTimeUnit, 1);
    }

    return periods;
  }

  @Override
  public String getIsoDate(DateTimeUnit dateTimeUnit, Calendar calendar) {
    return String.valueOf(dateTimeUnit.getYear());
  }

  @Override
  public String getIsoFormat() {
    return ISO_FORMAT;
  }

  @Override
  public String getIso8601Duration() {
    return ISO8601_DURATION;
  }

  @Override
  public Date getRewindedDate(Date date, Integer rewindedPeriods) {
    Calendar calendar = getCalendar();

    date = date != null ? date : new Date();
    rewindedPeriods = rewindedPeriods != null ? rewindedPeriods : 1;

    DateTimeUnit dateTimeUnit = createLocalDateUnitInstance(date);
    dateTimeUnit = calendar.minusYears(dateTimeUnit, rewindedPeriods);

    return calendar.toIso(dateTimeUnit).toJdkDate();
  }
}
